_____________________________________________________________________________

                             Q u i c k F i l e r

         Allows the Filer to be controlled by means of the keyboard

                        by David Thomas,  1997-2000
                         version 2.28 (16 Feb 2021)   32bit Martin Avison
_____________________________________________________________________________


Introduction

QuickFiler is a utility which allows you to use many standard shortcut keys
in conjunction with the RISC OS Filer.

QuickFiler requires a Risc PC-style !Boot application (or later).


Installation

Before you can use QuickFiler, it must be installed into your computers
boot sequence and your machine should be restarted.

Install QuickFiler by running the supplied !InstallQF application.  This
will copy across the program files to their correct place within the Boot
application, build an appropriate version of the QuickFiler program module
and generate new menu structures for the Filer. 

During Installation the QMessages file (see below) is validated against
the active Filer. If there is any Installation error, a message will be
displayed, any existing or new QuickFiler will be deleted from !Boot, and a
debug file will be generated called RAM:Filerxxx (if there is a RAM disc).
Please send this file to Martin Avison (for address see below) and the
problem should be easy to fix.

If the Installation is ok, you will find that the Filer gains the input
focus when you click in a directory display, and responds to the keyboard
shortcuts shown in the !Help which is displayed after installation. When
your machine has been restarted, the keyboard shortcuts will also be shown
on the Filers menus.

When QuickFiler installs, it creates a module specific to the version of
the Filer and its Messsages file you're using.  For this reason it is
usually required that you re-install QuickFiler if you upgrade your OS,
to avoid problems which can be quite nasty or confusing. 

If QuickFiler detects the Filer version or Messages file has changed since
installation, then immediately after a re-boot the QuickFiler Loader program
will issue an informatory message advising a Re-install. If this happens,
QuickFiler will NOT have been loaded to avoid any possible problems. The
message will persist after each re-boot until QuickFiler has been
Re-installed or Removed.


RISC OS Filer shortcut keys

Later versions of the RISC OS Filer have some shortcut keys built-in: 

  RISC OS Select v4 or v6 with Filer v2.78+ 
  RISC OS Open   v5.19+   with Filer v2.30+

However, I still have requests for QuickFiler for these Filer versions!
Unfortunately the keys they use are not the same keys QuickFiler uses.

So, please note that the default QuickFiler install...
  should cater for all known versions of RISC OS
  may be confused by Select and Open Filer modules with same version number
  may be a compromise for these later Filer versions
  may duplicate some RISC OS Filer shortcuts
  may replace some RISC OS Filer key functions
  ... but it should work! 

If anyone has any suggestions for improvements, please let me (Martin Avison)
know.

  
Shortcuts

QuickFiler can provide the following shortcut keys ( is SHIFT, ^ is CTRL),
but the actual keys available will depend on the RISC OS Filer version.

The !QFiler directory created in <Choices$Dir>.Boot.Tasks will have a
generated !Help file containing just the shortcuts for your particular
RISC OS version. This will be displayed at the end of the installation.
It may also include some keys provided by RISC OS (see above).

  Main Menu                             Display Menu
    Select all.................. ^A       Large icons................  F2
    Clear selection............. ^Z       Small icons................  F3
    New Directory........ Ins or ^D       Full info..................  F4
    Set directory...............Tab       Thumbnails.......#1........  F9
    Open parent................. ^B       Sort by name............... F1 
                                          Sort by type............... F2
  File Menu    (on objects selected)      Sort by size............... F3
    Copy........................ ^C       Sort by date............... F4
    Rename...................... ^R
    Delete.............Delete or ^X     Options Menu       #2
    Count....................... ^N       Confirm....................  F5
    Help......F1 or BackSpace or ^H       Confirm Deletes..#1........  F9
    Info........................ ^I       Verbose....................  F6
    Find........................ ^F       Force......................  F7
    Set type.................... ^T       Newer......................  F8
    Stamp....................... ^S       Faster...........#1........  F10
    Share..#1................... ^G
                                   
  Miscellaneous                         Access Menu  (on objects selected)
    Run selected.............Return       Protect.................... ^F5
    Close window.............   ^F2       Unprotect.................. ^F6
    Refresh Filer window.....   F11       Public..................... ^F7
    Scroll to top............  Home       Private.................... ^F8 
    Scroll to bottom.........   End       Access details.............  ^E 
 
  Scrolling          using: Up/Down   PageUp/PageDown
    Scroll to top............   ^Up .....  ^PageUp 
    Page up..................   Up .....    PageUp
    Scroll up line...........    Up .....   PageUp
    Scroll up Small..........  ^Up .....   ^PageUp
    Scroll down small........^Down ..... ^PageDown
    Scroll down line.........  Down ..... PageDown
    Page down................ Down .....  PageDown
    Scroll to bottom......... ^Down .....^PageDown


Notes:  #1 Not on all RO versions - only works if on Menu.
	#2 The Options key shortcuts will Tick the options.
	   To Untick the Option, use the Key plus  

If you attempt to use an unavailable shortcut, then QuickFiler will beep as a
warning.  The exception to this is Set directory (TAB) which always beeps.


DoubleClicks and Drags

If QuickFiler detects that an item in a Filer window has been DoubleClicked
or a Drag started, then if another window has the Input Focus it will give
the Input Focus back to the original window on the second click. This is
required (at least) for running some PipeDream command files.

Note that if RISC OS is less than v3.50, then a default DoubleClick time is
set as 1.00 seconds, which I think is correct. 
If v3.50 or greater, then the value is taken from the figure given by
	  *Status WimpDoubleClickDelay
but it is ONLY read when the QuickFiler module is started. This should not
be a problem, as the value rarely changes.

If a Drag is started to some (all?) versions of DrawWorks File Import
window, the Import window is closed. The only known solution to this at the
moment is to RMKill QuickFiler.


PC Delete Key Configuration

If the Select facility for setting the Delete key to behave like on a PC is
set (ie to delete the character AFTER the cursor, rather than before) then it
can cause some confusion when using QF, as the Delete key no longer works.

The effect of the PC Delete option seems to be to change the code used for
the Delete key from &7F to &18B. This causes QF to not recognise it.

However, &18B is the same code as used for the End key (regardless of PC
Delete setting), so with PC Delete it just duplicates the End key.

As End is used in QF to scroll to the bottom (try it with a long list)
then Delete will do the same with PC Delete on. Worse than that, it makes
it impossible (as far as I know) for a program to differentiate between
the keys!

So, I can see only two options:

1.  Turn PC Delete off, and use End when you want to delete the next
character

2.  If you want to use PC Delete AND Delete in QF, change the QF QMessages
file :

(a) to put a # at the start to comment the line out which says
    None    Scroll to Bottom    End     Scroll_Bottom
(b) change the Del to End in the line  
    None   Delete   Del   1.2   Menu   Selection
but you will no longer have the Scroll-to-End facility (unless you can
find another key which you could use).


Removal

Should you wish to remove QuickFiler from your system, re-run !InstallQF. 
You will be given the option of removing QuickFiler from your Boot sequence.


QMessages File

From v2.06 the QMessages file contains not only the changes to the Filer
menus, but also the actions taken for the shortcuts. 

This file can be changed, if you are careful and wish to change the
shortcuts used.

The columns must be Tab separated, otherwise strange (nasty?) things may
happen. Not all error conditions may be catered for!

To remove a shortcut, put a # at the start of the line.

To change a shortcut, change the value of the 'Key' column. 
You are advised NOT to change any other values!

Token	  The value of the Token in the Filer Messages to change. 
	  'None' means there is no menu token.
	  '++++' means it is just a heading for the !Help file.
	  'Help' means it is just a line    for the !Help file.
Text	  must be the exact value of the standard Filer Menu text.
	  If not, an error is raised during installation.
Key	  is the key shortcut to be used and added to the menu.
	  Values that can be used are ...
	  	    Single characters, with Ctrl and/or Shift
	  	    F1-F12, with Ctrl and/or Shift
	  	    Up or Dn, with Ctrl and/or Shift
	  	    Home, Del, Ins, Tab, End, PgUp, PgDn, Return
	  	    Lwin, Rwin, Menu (Windows keyboards only)
Menu	  is the menu selection value(s). Zero is the first entry.
	  1.2.3 is entry +1 on first menu, then +2 on submenu, then +3 on 
	  next submenu.  
Action	  is the action to be taken by the program for this key.
	  Only values listed are valid! Consult before changing!!
	  'None' means no action by QF, but may be in generated !Help.
MinVer	  is the minimum version of Filer where this is applicable.
	  Blank is always.
MaxVer	  is the maximum version of Filer where this is applicable.
	  Blank is always.
Notes	  are for any general comments.

Changes to this file are only used when !InstallQF is run. 

	  
Compatibility

TreeMenu (unknown version) by Julian Smith has been reported to cause
problems with QuickFiler.  Director by Nick Craig-Wood is an alternative,
with no compatibility problems.  <URL:http://www.axis.demon.co.uk/>.


Credits

Thanks to Mr MoZes and many others for testing.


History

2.28 (16 Feb 2021)  Martin Avison
 - Fixed 41 ZeroPain errors when Refresh (F11) is used.

2.27 (15 May 2020)  Martin Avison
 - Added version check to failure message.

2.26 (18 Apr 2020)  Martin Avison
 - Added FNKeyDesc so !Help was printable.

2.25 (03 Mar 2020)  Martin Avison
 - Changes to enable using with RO5.27 Filer 2.47.

2.24 (18 Jul 2015)  Martin Avison
 - Changes to avoid ZeroPain problems.

2.23 (01 Aug 2013)  Martin Avison
 - Changes to enable using with RO5.19+ better.

2.22 (01 Feb 2010)  Martin Avison
 - Corrected email address in program

2.21 (15 May 2007)  Martin Avison
 - Fixed problem when using RISC OS 6.06
 - Added note to Help about PC Delete
 
2.20 (29 Dec 2006)  Martin Avison
 - Temporary debug version.
 
2.19 (23 Sep 2005)  Martin Avison
 - Introduced LoadQF program so that QF will NOT be loaded if either the 
   Filer module or Messages file has changed to avoid possible problems.
 
2.18 (12 Feb 2005)  Martin Avison
 - Made Filer Refresh facility work from pathname: type displays
 
2.17 (26 Jan 2005)  Martin Avison
 - Added Filer Refresh facility
 
2.15 (26 May 2004)  Martin Avison
 - Added checks on Messages date & delete if changed

2.14 (15 May 2004)  Martin Avison
 - Click-Drag returns Input Focus to originator

2.13 (18 Nov 2003)  Martin Avison
 - Enabled Install to RMLoad new module

2.12 (29 Apr 2004)  Martin Avison
 - Updated QMessages to work with RISC OS v4.39 Adjust.
 
2.12 (13 Nov 2003)  Martin Avison
 - Fixed test for WrongFiler if RO < 3.80
 - Fixed flags for Tasks Copy (FSControl 26) and Wipe (FSControl 27)
 - Stopped Select/Adjust+Hold being treated as DoubleClick
 
2.11 (14 Oct 2003)  Martin Avison
 - Fixed Filer abort if Return commented out
 - Added module tests for Filer version = Generated version
 
2.10 (08 Sep 2003)  Martin Avison
 - Catered for Filer DoubleClicks not stealing InputFocus
 - Caters for Select 3 RO4.37 Filer 2.65

2.09 (14 Aug 2003)  Martin Avison
 - Catered for Insert, Home, End, Return, Lwin, Rwin, & Menu keys
 
2.08 (10 Aug 2003)  Martin Avison
 - Changed internal flags to bits
 - Displayed generated !Help at end of install
 - Added Quit option if already installed
 
2.07 (09 Aug 2003)  Martin Avison
 - Changed Options key shortcuts from toggling the option unseen
   to specific Tick and Untick keys.
   
2.06 (04 Aug 2003)  Martin Avison
 - Generated Filer Messages from extended QMessages file 
 - Generated !Help file from extended QMessages file
 - Deleted QuickFiler from !Boot if an error
 - Validated Tokens - ERROR if Text mismatch or unused
 - Added debug file if installation error.
 - Updated Help file

2.05 (30 Jul 2003)  Martin Avison
 - Generated Key handling code from extended QMessages file 

2.04 (30 Jul 2003)  Martin Avison
 - Changed Thumbnail display from ShF5 to F9 so no clash!
 
2.03 (28 Jul 2003)  Martin Avison
 - Added F1 as alternative for Ctrl-H (Help) 
 - Catered for Select 4.36 Filer 2.56 Thumbnail display
 - Added WimpSWIve LOAD program to ensure 0.08 is loaded   
 
2.02 (08 Jul 2003)  Martin Avison
 - Omitted processing of non-existant menu items
 
2.01 (23 Jun 2003)  Martin Avison
 - Modified for 32bit compatibility.
 - Corrected some !Help keys information
 
2.00 (21 Oct 2000)
 - QuickFiler can now (at last) activate sub-windows and sub-menus, so all
   Filer menu functions can be controlled via shortcuts.
   
   It can also now run objects and set the current directory.

 - New shortcut keys:
     TAB                - sets the currently selected directory, then
                          bleeps.  This is equivalent to the "Set work
                          directory" entry in RISC OS 4, except that
                          QuickFiler handles it itself and so its available
                          on all supported OSes. (Stuart Winter.)

     ^UP, ^DOWN       - move up or down by four OS units (i.e. scroll very
                          slightly.)

 - RISC OS 4 compatbility.  Previous versions were not aware of Alt-click
   renames, which could lead to crashes.  New style service call handler.

 - Rewritten installer builds an appropriate module when installing, plus
   asks the user whether they would like to remove an existing installation,
   if detected.

1.28 (01 Jun 1998)
 - Fix: Service call handling was faulty, leading to problems when new
   desktop Filers were activated. e.g. RAMFS Filer.
 - Fix: The way Ctrl-F2 was implemented turned out to be not acceptable.  It
   has been reimplemented in the correct manner.  Note that Shift-Ctrl-F2
   will duplicate the action of ^B (Open parent) due to the way that this
   works.
 - Fix: Key Pressed events are not now passed on to the Filer if they are
   handled, stopping the keypresses getting passed on to tasks with hot key
   windows.  (Brian Howlett.)
 - Some new shortcut keys: :-)
     UP, DOWN           - scroll window up or down by one icon row
     ^UP, ^DOWN         - scroll window to the top or bottom of the display
     PAGE UP, PAGE DOWN - scroll window up or down by one page

1.25 (02 Apr 1998)
 - Added Ctrl-F2 to close directory viewer window (James Lawson.)
 - Responds correctly to Filer and FilterManager resets and reinits.
 - The module has been recoded in key areas, so despite the new features its
   only slightly bigger than the previous version.

1.10 (22 Oct 1997)
 - Thanks to Reuben Thomas, Chris Ward and Ian Scott for pointing out that
   QuickFiler didnt work on RISC OS 3.7 due to missing Message tokens.
   This version now reads the Filer messages from ROM and converts them
   appropriately before installing.
 - Templates file is not supplied anymore.
 - An Installer program, to facilitate the above.
 - Keys are referred to as shortcuts now, rather than hot-keys

1.00 (22 May 1997)
 - First Release.


Credits

Thanks to Ting Zwei Kuei for writing FilerKeys which didnt work quite how I
wanted it to, so I wrote this!

Many thanks to Andrew Clover for the WimpSWIVe module which makes an
otherwise impossible job, possible. :-)  The WSWI-Help document (supplied)
documents the module.  [http://www.doggysoft.co.uk/]


Copyright

  This software is the copyrighted work of David Thomas.  It is supplied as
is; you use it entirely at your own risk.  In no circumstances will the
author be liable for any loss arising from the use or inability to use this
software.  The author makes no warranty as to the fitness of this software
for any purpose.


Contacting the Author

From v2.01 onwards I (Martin Avison) have been maintaining QuickFiler, with
Dave's permission.  If you have any queries about versions 2.01 onwards,
please do not blame Dave, as it is probably my fault, so please contact me
(Martin Avison) at QFiler@avisoft.f9.co.uk  The latest version will be on
http://www.avisoft.f9.co.uk

***  Please do NOT publish these details anywhere,   ***
***  especially in any text on the Internet!         ***

If you have any comments on versions before v2.01, then you can contact
Dave via his web site at http://www.davespace.co.uk

If you have a question, then please check it has not already been answered
in this documentation before mailing.

_____________________________________________________________________________

